///////////////////////////////////////////////////////////////////////////////
// Copyright (c) Lewis Baker
// Licenced under MIT license. See LICENSE.txt for details.
///////////////////////////////////////////////////////////////////////////////
#ifndef CPPCORO_READ_WRITE_FILE_HPP_INCLUDED
#define CPPCORO_READ_WRITE_FILE_HPP_INCLUDED

#include <cppcoro/file_buffering_mode.hpp>
#include <cppcoro/file_open_mode.hpp>
#include <cppcoro/file_share_mode.hpp>
#include <cppcoro/readable_file.hpp>
#include <cppcoro/writable_file.hpp>

#include <filesystem>

#if CPPCORO_OS_WINNT

namespace cppcoro {
  class read_write_file : public readable_file, public writable_file {
  public:
    /// Open a file for read-write access.
    ///
    /// \param ioContext
    /// The I/O context to use when dispatching I/O completion events.
    /// When asynchronous write operations on this file complete the
    /// completion events will be dispatched to an I/O thread associated
    /// with the I/O context.
    ///
    /// \param pathMode
    /// Path of the file to open.
    ///
    /// \param openMode
    /// Specifies how the file should be opened and how to handle cases
    /// when the file exists or doesn't exist.
    ///
    /// \param shareMode
    /// Specifies the access to be allowed on the file concurrently with this file access.
    ///
    /// \param bufferingMode
    /// Specifies the modes/hints to provide to the OS that affects the behaviour
    /// of its file buffering.
    ///
    /// \return
    /// An object that can be used to write to the file.
    ///
    /// \throw std::system_error
    /// If the file could not be opened for write.
    [[nodiscard]] static read_write_file open(
        io_service &ioService,
        const std::filesystem::path &path,
        file_open_mode openMode = file_open_mode::create_or_open,
        file_share_mode shareMode = file_share_mode::none,
        file_buffering_mode bufferingMode = file_buffering_mode::default_);

  protected:
#if CPPCORO_OS_WINNT
    read_write_file(detail::win32::safe_handle &&fileHandle) noexcept;
#endif
  };
}// namespace cppcoro

#endif
#endif
